Nhảy tới nội dung

Các API của luồng chuyển tiền

1. API khởi tạo phiên​

1.1. Request Url​

POST base_url/biometric/init

1.2. Request Headers​

Tham sốYêu cầuGiá trị mặc địnhMô tả
api-keyCóAPI key để sử dụng hệ thống FPT AI eKYC
client_uuidKhôngUUID sinh ra từ hệ thống của khách hàng để tự quản lý phiên eKYC
device-typeCóThiết bị đang sử dụng, các giá trị cho phép bao gồm:
  • android
  • ios
  • web-sdk
langKhôngviNgôn ngữ sử dụng, các giá trị cho phép bao gồm:
  • en
  • vi

1.3. Mẫu request​

curl --location --request POST 'base_url/biometric/init' \
--header 'api-key: your-api-key' \
--header 'device-type: android' \
--header 'client_uuid: your-uuid'  \
--header 'lang: vi'

1.4. Response​

1.4.1. Mẫu response​

  • Thành công: http_code = 200
{
    "code": "200",
    "message": "success",
    "session-id": "tsan_ekyc__ef1e2944-91b0-4506-8a1a-8f39a80b309c",
    "sdk_config": {
        "is_show_ekyc_result": true,
        "liveness_type": 1,
        "show_guide": 3,
        "disable_liveness": false,
        "show_switch_button": 1,
        "limit": 5,
            "font_path": {
            "regular": "",
            "medium": "",
            "bold": ""
            }
    }
}
  • Thất bại: http_code != 200

1.4.2. Mô tả response​

Tham sốLoại dữ liệuMô tảGhi chú
codeStringMã trạng thái trả về của yêu cầu200: Thành công
messageStringThông báo lỗi trả về (nếu có)
  • 200: Thành công
  • 401: Lỗi xác thực
  • 403: Lỗi dùng sai session-id
  • 504: Lỗi kết nối hệ thống
  • 500: Lỗi server hệ thống
session-idStringMã ID duy nhất của phiên eKYC được sinh ra bởi eKYC Backend. session-id sau đó phải được gửi kèm trong headers của tất cả các request trong cùng phiên
sdk_configStringCấu hình hiện tại của luồng eKYC

2. API kiểm tra liveness và so khớp khuôn mặt​

2.1. Request Url​

POST base_url/biometric/verify

2.2. Request Headers​

Tham sốYêu cầuLoại dữ liệuMô tảChú ý
session-idCóStringID duy nhất của phiên eKYC nhận được từ bước khởi tạo phiên
api-keyCóStringPI key để sử dụng hệ thống FPT AI eKYC
autoCóStringĐặt giá trị là True khi gửi từ FPT SDK. Nếu không phải đặt False
device-typeCóStringThiết bị đang sử dụng, các giá trị cho phép bao gồm:
  • android
  • ios
  • web-sdk
langKhôngStringNgôn ngữ sử dụng, các giá trị cho phép bao gồm:
  • en
  • vi
default: en

2.3. Request Body​

FormData chứa ảnh hoặc video selfie sử dụng để kiểm tra.

Tham sốYêu cầuGiá trị mặc địnhMô tả
selfiesKhông. Sử selfies hoặc videoArrayẢnh selfie được thu thập để kiểm tra liveness và thực hiện face matching
videoKhông. Sử selfies hoặc videoFileVideo selfie được thu thập để kiểm tra liveness và thực hiện face matching
cmndKhông. Sử dụng cmnd hoặc vectorFileFile ảnh khuôn mặt của người dùng đã được xác thực lưu trong hệ thống của khách hàng. Ảnh này sẽ được dùng để thực hiện face matching
vectorKhông. Sử dụng cmnd hoặc vectorFileVector khuôn mặt của người dùng đã được xác thực lưu trong hệ thống của khách hàng. Vector này sẽ được dùng để thực hiện face matching

2.4. Mẫu request​

curl --location --request POST 'base_url/biometric/verify' \
--header 'api-key: your-api-key' \
--header 'session-id: 7760a743-884b-4195-b781-892e72c7b0b6'
--header 'device-type: android' \
--header 'lang: vi' \
--form 'selfies=@"path-to-selfie-image"' \
--form 'vector="..."'

2.5. Response​

2.5.1. Mẫu response thành công​

{
    "code": "200",
    "message": "Kiểm tra thực thể sống thành công",
    "liveness": {
        "code": "200",
        "message": "liveness check successful",
        "is_live": "true",
        "spoof_prob": "N/A",
        "need_to_review": "N/A",
        "is_deepfake": "N/A",
        "deepfake_prob": "N/A",
        "warning": "N/A",
    },
    "face_match": {
        "code": "200",
        "message": "face matching successful",
        "isMatch": "true",
        "similarity": "95.84",
        "warning": "N/A"
    },
    "is_complete_session": false
}

2.5.2. Mô tả response​

Tham sốLoại dữ liệuMô tảGhi chú
codeStringResponse status code of the request. Code 200 means request success.Details can be found in the document error code
messageStringError message of the request (if any). Language of message is set by lang in headers
livenessObjectreturned liveness result
face_matchObjectreturned face match result
is_complete_sessionBooleanDefine whether session is completed. If False, user can retry with face verify, otherwise, users have to try with another session

2.5.3. Mẫu response lỗi​

{
    "code": "303",
    "message": "Khuôn mặt không khớp với giấy tờ",
    "liveness": {
        "code": "200",
        "message": "liveness check successful",
        "is_live": "true",
        "spoof_prob": "N/A",
        "need_to_review": "N/A",
        "is_deepfake": "N/A",
        "deepfake_prob": "N/A",
        "warning": "N/A",
    },
    "face_match": {
        "code": "303",
        "message": "face is not matching with document",
        "isMatch": "false",
        "similarity": "5.84",
        "warning": "N/A"
    },
    "is_complete_session": false
}
{
    "code": "407",
    "message": "2 faces exist",
    "liveness": {
        "code": "200",
        "message": "liveness check successful",
        "is_live": "true",
        "spoof_prob": "N/A",
        "need_to_review": "N/A",
        "is_deepfake": "N/A",
        "deepfake_prob": "N/A",
        "warning": "N/A",
    },
    "face_match": {
        "code": "407",
        "message": "2 faces exist",
        "isMatch": "N/A",
        "similarity": "N/A",
        "warning": "N/A"
    },
    "is_complete_session": false
}